API Documentation
Static Public Member Functions | List of all members
nkAstraeus::ScriptsEngine Class Referencefinal

Drives the scripting sub engine. More...

Static Public Member Functions

static nkScripts::EnvironmentgetLuaScriptEnvironment ()
 
static bool initialize ()
 
static void shutdown ()
 

Detailed Description

Drives the scripting sub engine.

The scripting engine wraps a big part of the C++ API, enabling dynamic programming in a live environment.

Member Function Documentation

◆ getLuaScriptEnvironment()

static nkScripts::Environment* nkAstraeus::ScriptsEngine::getLuaScriptEnvironment ( )
static
Returns
The Lua scripting environment initialized by the sub component.

◆ initialize()

static bool nkAstraeus::ScriptsEngine::initialize ( )
static

Initializes the scripting sub component. Under the hood, this will create a nkScripts::Environment and populate it with all functions necessary to use the API.

Returns
Whether the initialization went well (true) or not (false).

◆ shutdown()

static void nkAstraeus::ScriptsEngine::shutdown ( )
static

Shuts down the sub component. This will free the scriptin environment and free its memory.


The documentation for this class was generated from the following file: